/*
 * Copyright (c) 1998-2011 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *   Free SoftwareFoundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package javax.ejb;

import javax.transaction.UserTransaction;
import java.security.Identity;
import java.security.Principal;
import java.util.Map;
import java.util.Properties;

/**
 * The main ejb context.
 */
public interface EJBContext {
  public Identity getCallerIdentity();

  public Principal getCallerPrincipal();
  
  public Map<String,Object> getContextData();

  public EJBHome getEJBHome();

  public EJBLocalHome getEJBLocalHome();
  
  public Properties getEnvironment();
  
  // XA

  public UserTransaction getUserTransaction()
    throws IllegalStateException;

  public boolean getRollbackOnly()
    throws IllegalStateException;

  public void setRollbackOnly()
    throws IllegalStateException;
  
  // security

  public boolean isCallerInRole(Identity role);

  public boolean isCallerInRole(String roleName);

  public Object lookup(String name);
  
  // timer
  
  public TimerService getTimerService()
    throws IllegalStateException;

}
